<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<title>StarShipInfo Class</title>
</head>

<body text="#FFFFFF" bgcolor="#000000" style="font-family: Verdana; font-size: 10pt" link="#00FFFF" vlink="#00FFFF" alink="#00FFFF">

<p><font size="3"><b>StarShipInfo Class</b></font></p>
<p>The StarShipInfo class represents the information about a 
<a href="StarShips.htm">StarShip</a> that is 
available to your <a href="Brain%20Programming.htm">Brain</a>.&nbsp; Your Brain accesses a list 
of StarShipInfo objects via its StarShips and MyStarShips properties.&nbsp; Only 
StarShips that are visible to your Brain are exposed in these lists.</p>
<p><font color="#FFFF00"><b>General Properties</b></font></p>
<p>These properties are available to all StarShipInfo objects.</p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>bool</b></font><font SIZE="2"><font color="#00FFFF"> </font>
OwnedByMe<br>
Returns true if the <a href="StarShips.htm">StarShip</a> is owned by the Player that the Brain is 
controlling.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>bool</b></font><font SIZE="2"> IdentifiedByMe<br>
Returns true if the <a href="StarShips.htm">StarShip</a> has been identified by the Player controlling the 
Brain.&nbsp; StarShips that have not been identified yet appear as question mark 
symbols on the map.&nbsp; For unidentified StarShips, many of the descriptive 
properties below will not return correct values, so be sure to check to see if 
the StarShip has been identified before performing any actions based on those 
properties.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>bool</b></font><font SIZE="2"><font color="#00FFFF"> </font>
TaggedByMe<br>
Returns true if the <a href="StarShips.htm">StarShip</a> has been tagged by one the Brain's
<a href="InkSpot.htm">InkSpots</a>.</p>
</font>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> Point</font><font SIZE="2"> Location<b><font SIZE="2" COLOR="#0000ff"><br>
</font><font SIZE="2" color="#00FFFF">public</font></b><font SIZE="2" color="#00FFFF">
<b>int</b></font> X<b><font SIZE="2" COLOR="#0000ff"><br>
</font><font SIZE="2" color="#00FFFF">public</font></b><font SIZE="2" color="#00FFFF">
<b>int</b></font><font color="#00FFFF"> </font>Y<br>
These properties provide access to the <a href="StarShips.htm">StarShip's</a> location.</font></p>
<p><b><font color="#FFFF00">Descriptive Properties</font></b></p>
<p>These properties will return correct values only if the 
<a href="StarShips.htm">StarShip</a> is 
identified to your Brain.&nbsp; Unidentified StarShips will return zero or false, 
depending on the property return type.</p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>bool</b></font><font SIZE="2"> AttackAdjacent<br>
Returns whether or not the Brain has set the <a href="StarShips.htm">StarShip</a> to automatically attack 
adjacent enemy StarShips.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"> Cargo<br>
Returns the number of Resources currently being carried by a
<a href="Freighter.htm">Freighter</a>.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> IList&lt;<b>int</b></font><font SIZE="2"><font color="#00FFFF">&gt;</font> 
CloakArrows<br>
Returns a list of integers that contains the directions that cloaked 
<a href="StarShips.htm">StarShips</a> 
have been detected by a <a href="CloakDetector.htm">CloakDetector</a>.&nbsp; The 
directions are expressed as 0=North, 1=NorthEast, etc.</p>
</font><font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>bool</b></font><font SIZE="2"><font color="#00FFFF"> </font>
Cloaked<br>
Returns true if the <a href="StarShips.htm">StarShip</a> is cloaked.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>string</b></font><font SIZE="2"> Code<br>
Returns the <a href="StarShips.htm">StarShip's</a> unique 3 character code.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"> EffectiveWeapons<br>
Available only to <a href="StarShips.htm">StarShips</a> owned by the Brain.&nbsp; Returns the effective 
Weapons rating, which is the <a href="WarShip.htm">WarShip</a> or
<a href="DoppleShip.htm">DoppleShip's</a> Weapons rating plus the influence of
<a href="CommandShip.htm">CommandShips</a> in range.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"><font color="#00FFFF"> </font>
Engines<br>
Returns the <a href="StarShips.htm">StarShip's</a> Engine rating.</p>
</font><font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> StarSystemInfo</font><font SIZE="2"> Dragging<br>
Returns the <a href="StarSystems.htm">StarSystem</a> that a <a href="GravShip.htm">GravShip</a> is currently 
dragging, or null if the ship is not dragging.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>double</b></font><font SIZE="2"><font color="#00FFFF"> </font>
Health<br>
An expression of the damage done to the <a href="StarShips.htm">StarShip</a>.&nbsp; A value of 100% 
indicates a StarShip with no damage.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>bool</b></font><font SIZE="2"><font color="#00FFFF"> </font>
IsDamaged<br>
Returns true if the <a href="StarShips.htm">StarShip</a> has suffered any damage.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"> KnownWeapons<br>
Returns an unidentified enemy <a href="StarShips.htm">StarShip's</a> known Weapons rating.&nbsp; This value 
is determined once the StarShip interacts with one of your own StarShips, and 
appears on the map as a &quot;W&quot; value with a question mark next to it; i.e. &quot;W4?&quot;.&nbsp; 
For example, assume an enemy unidentified StarShip has destroyed one of your
<a href="WarShip.htm">WarShips</a> that had 5 Weapons.&nbsp; The Weapons rating 
of the enemy StarShip must be at least 6.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"> MaxEngines<br>
Returns the maximum number of Engines (without considering damage) of the
<a href="StarShips.htm">StarShip</a>.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"> MaxValue<br>
Returns the maximum rating of the <a href="StarShips.htm">StarShip's</a> Primary System (without considering 
damage).</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b>
OrderType</font><font SIZE="2"> Order<br>
Returns the type of order currently assigned to the <a href="StarShips.htm">StarShip</a>.&nbsp; OrderType is 
an enum that contains descriptive values of all of the possible order types.&nbsp; 
The method will return OrderType.None if the StarShip does not have an order.</p>
</font><font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>string</b></font><font SIZE="2"> Owner<br>
Returns a string indicating the name of the <a href="StarShips.htm">StarShip's</a> owner.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"><font color="#00FFFF"> </font>
OwnerInt<br>
Returns the integer index of the Player owning the <a href="StarShips.htm">StarShip</a>.&nbsp; The index 
values range from 0 to Number of Players - 1.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"><font color="#00FFFF"> </font>
Resources<br>
Returns the number of Resources currently being held at a
<a href="BattleStation.htm">BattleStation</a>.</p>
</font><font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> StarShipType</font><font SIZE="2"> ShipType<br>
Returns the StarShipType of the <a href="StarShips.htm">StarShip</a>.&nbsp; StarShipType is an enum type 
that contains the values of the 28 available StarShip types.&nbsp; If the 
StarShip is unidentified, the methods returns StarShipType.WarShip.</font></p>
<font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> StarShipInfo</font><font SIZE="2"><font color="#00FFFF"> </font>
TuggedBy<br>
If the <a href="StarShips.htm">StarShip</a> is being tugged by a <a href="Tug.htm">Tug</a>, this property 
returns the StarShip doing the tugging, otherwise the property returns null.</p>
</font><font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> StarShipInfo</font><font SIZE="2"><font color="#00FFFF"> </font>
Tugging<br>
Returns the <a href="StarShips.htm">StarShip</a> that a <a href="Tug.htm">Tug</a> is currently tugging, or 
null if the ship is not tugging.</p>
</font><font SIZE="2" COLOR="#00FFFF"><b>
<p>public</b> <b>int</b></font><font SIZE="2"><font color="#00FFFF"> </font>
Value<br>
Returns the rating of the <a href="StarShips.htm">StarShip's</a> Primary System; Weapons for
<a href="WarShip.htm">WarShips</a>, Scanners for <a href="ScanShip.htm">
ScanShips</a>, etc.</p>
</font>

</body>

</html>